/**
 * @(#)CoordinadorBundleProperties.java Jan 31, 2007
 *
 * Copyright (c) 2005-2010 Psiqueware S.A. de C.V. All Rights Reserved.
 * This software is the proprietary information Psiqueware S.A. de C.V.
 * Use is subject to license terms.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * <br/>Usuario : AngelElectrico
 * <br/>Creaci&oacute;n: Jan 31, 2007 - 12:13:43 PM
 * <br/>
 * <br/>
 * <br/><t5>Cambios :</t5>
 * <br/><b>Fecha | Autor  |  Cambios</b>
 * <ul>
 * <li>Jan 31, 2007 | <a href = "mailto:AngelElectrico@PsiqueWare.com">Angel El&eacute;ctrico</a> | Creaci&oacute;n del Objeto.</li>
 *
 * </ul>
 */

package com.psiqueware.alheli.i18n;

import com.psiqueware.alheli.i18n.propertyBundles.BasicoResourceBundleCombinado;

import java.io.Serializable;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;

/**
 * Administra los {@link ResourceBundle} del sistema para los diferentes contextos.
 * <br/>Paquete Original: com.psiqueware.basico.i18n
 * <br/>Nombre  Original: CoordinadorBundleProperties
 * <br/>Oprima para ver : <a href="CoordinadorBundleProperties.java.html"><i>C&oacute;digo Fuente</i> </a>
 *
 * @author <a href="mailto:AngelElectrico@PsiqueWare.com">Angel El&eacute;ctrico</a>
 * @version Revision: 1.1 Jan 31, 2007 12:13:43 PM
 * @noinspection OverloadedMethodsWithSameNumberOfParameters
 */
public interface CoordinadorBundles extends Serializable
{

    /**
     * Agrega un {@link ResourceBundle} a la colecci&oacute;n coordinada.
     *
     * @param contexto en el que se definir&aacute; el Bundle.
     * @param baseName nombre base del bundle.
     */
    void agregarResourceBundle(final String contexto, final String baseName);

    /**
     * Agrega un {@link ResourceBundle} a la colecci&oacute;n coordinada.
     *
     * @param contexto      en el que se definir&aacute; el Bundle.
     * @param classBaseName nombre base del bundle.
     */
    void agregarResourceBundle(final String contexto, final Class classBaseName);

    /**
     * Agrega un {@link ResourceBundle} a la colecci&oacute;n coordinada.
     *
     * @param baseName nombre base del bundle.
     */
    void agregarResourceBundle(final String baseName);

    /**
     * Agrega un {@link ResourceBundle} a la colecci&oacute;n coordinada.
     *
     * @param classBaseName nombre base del bundle.
     */
    void agregarResourceBundle(final Class classBaseName);

    /**
     * Agrega un {@link ResourceBundle} a la colecci&oacute;n coordinada y lo devuelve.
     *
     * @param contexto en el que se definir&aacute; el Bundle.
     * @param baseName nombre base del bundle.
     * @param locale   {@link Locale} del bundle buscado.
     *
     * @return {@link ResourceBundle} buscado.
     */
    ResourceBundle agregaBuscaResourceBundle(final String contexto, final String baseName, final Locale locale);

    /**
     * Agrega un {@link ResourceBundle} a la colecci&oacute;n coordinada y lo devuelve.
     *
     * @param contexto      en el que se definir&aacute; el Bundle.
     * @param classBaseName nombre base del bundle.
     * @param locale        {@link Locale} del bundle buscado.
     *
     * @return {@link ResourceBundle} buscado.
     */
    ResourceBundle agregaBuscaResourceBundle(final String contexto, final Class classBaseName, final Locale locale);

    /**
     * Agrega un {@link ResourceBundle} a la colecci&oacute;n coordinada y lo devuelve.
     *
     * @param classBaseName nombre base del bundle.
     * @param locale        {@link Locale} del bundle buscado.
     *
     * @return {@link ResourceBundle} buscado.
     */
    ResourceBundle agregaBuscaResourceBundle(final Class classBaseName, final Locale locale);

    /**
     * Agrega un {@link ResourceBundle} a la colecci&oacute;n coordinada y lo devuelve.
     *
     * @param baseName nombre base del bundle.
     *
     * @return {@link ResourceBundle} buscado.
     */
    ResourceBundle agregaBuscaResourceBundle(final String baseName);

    /**
     * Agrega un {@link ResourceBundle} a la colecci&oacute;n coordinada y lo devuelve.
     *
     * @param classBaseName nombre base del bundle.
     *
     * @return {@link ResourceBundle} buscado.
     */
    ResourceBundle agregaBuscaResourceBundle(final Class classBaseName);

    /**
     * Devuelve un ResourceBundle para un {@link Locale} y contexto espec&iacute;ficos.
     *
     * @param locale   localidad cuyos recursos se buscan.
     * @param contexto para el Bundle.
     *
     * @return {@link ResourceBundle}.
     */
    ResourceBundle getBundle(Locale locale, String contexto);

    /**
     * Devuelve un ResourceBundle para el {@link Locale} sin importarle el contexto de los recursos.
     *
     * @param locale localidad cuyos recursos se buscan.
     *
     * @return {@link ResourceBundle}.
     */
    ResourceBundle getBundle(Locale locale);

    /**
     * Devuelve un ResourceBundle sin importarle el contexto de los recursos y utilizando el {@link Locale} por defecto.
     *
     * @return {@link ResourceBundle}.
     */
    ResourceBundle getBundle();


    public static class Util
    {

        /**
         * Combina dos Bundles en uno Solo.
         *
         * @param bundleA a combinar.
         * @param bundleB a combinar.
         *
         * @return ambas Bundles combinadas.
         */
        public static ResourceBundle combinarBundles(ResourceBundle bundleA, ResourceBundle bundleB)
        {
            final BasicoResourceBundleCombinado combinado = new BasicoResourceBundleCombinado(bundleA.getLocale());
            combinado.agregarRecursos(bundleA);
            combinado.agregarRecursos(bundleB);
            return combinado;
        }


        /**
         * Devuelve un mapa con todas las llaves y valores del {@link ResourceBundle}.
         * Es &uacute;til cuando no se quieren excepciones al no encontrar una llave.
         *
         * @param bundle a mapear.
         *
         * @return el {@link Map} creado.
         */
        public static Map<String, String> mapear(final ResourceBundle bundle)
        {
            final Map<String, String> salida = new HashMap<String, String>();

            final Enumeration<String> keys = bundle.getKeys();
            while (keys.hasMoreElements())
            {
                final String key = keys.nextElement();
                salida.put(key, bundle.getString(key));
            }
            return salida;
        }

    }
}
